﻿using System;

namespace HeroldIT.Dnn.SkinObjects
{
    /// <summary>
    /// The arguments passed to a <see cref="Breadcrumb"/>'s events.
    /// </summary>
    public class BreadcrumbEventArgs : EventArgs
    {
        #region properties

        /// <summary>
        /// Gets the breadcrumb part's tab id.
        /// </summary>
        public int TabId { get; private set; }

        /// <summary>
        /// Gets or sets the name to render for the breadcrumb part.
        /// </summary>
        public string NameToRender { get; set; }

        /// <summary>
        /// Gets or sets the url to render for the breadcrumb part.
        /// </summary>
        public string UrlToRender { get; set; }

        /// <summary>
        /// Getsor sets whether to omit the breadcrumb part.
        /// </summary>
        public bool OmitBreadcrumbPart { get; set; }

        #endregion

        #region constructors

        /// <summary>
        /// Creates a new <see cref="BreadcrumbEventArgs"/> object.
        /// </summary>
        /// <param name="tabId">The part's tab id.</param>
        /// <param name="nameToRender">The name to render for the tab.</param>
        /// <param name="urlToRender">The url to render for the tab.</param>
        public BreadcrumbEventArgs(int tabId, string nameToRender, string urlToRender)
        {
            this.TabId = tabId;
            this.NameToRender = nameToRender;
            this.UrlToRender = urlToRender;
        }

        #endregion
    }
}
